home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmSeparator.z / XmSeparator
Encoding:
Text File  |  1998-10-20  |  18.2 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr - The Separator widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////SSSSeeeeppppaaaarrrraaaattttoooorrrr....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           Separator is a primitive widget that separates items in a
  20.           display.  Several different line drawing styles are
  21.           provided, as well as horizontal or vertical orientation.
  22.  
  23.           The Separator line drawing is automatically centered within
  24.           the height of the widget for a horizontal orientation and
  25.           centered within the width of the widget for a vertical
  26.           orientation.  An XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss with a new XXXXmmmmNNNNsssseeeeppppaaaarrrraaaattttoooorrrrTTTTyyyyppppeeee
  27.           resizes the widget to its minimal height (for horizontal
  28.           orientation) or its minimal width (for vertical orientation)
  29.           unless height or width is explicitly set in the XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss
  30.           call.
  31.  
  32.           Separator does not draw shadows around the separator.  The
  33.           Primitive resource XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss is used for the
  34.           Separator's thickness when XXXXmmmmNNNNsssseeeeppppaaaarrrraaaattttoooorrrrTTTTyyyyppppeeee is
  35.           XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN, XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN____DDDDAAAASSSSHHHH,
  36.           XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT, or XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT____DDDDAAAASSSSHHHH.
  37.  
  38.           Separator does not highlight and allows no traversing.  The
  39.           primitive resource XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrssssaaaallllOOOOnnnn is forced to False.
  40.  
  41.           The XXXXmmmmNNNNsssseeeeppppaaaarrrraaaattttoooorrrrTTTTyyyyppppeeee of XXXXmmmmNNNNOOOO____LLLLIIIINNNNEEEE provides an escape to the
  42.           application programmer who needs a different style of
  43.           drawing.  A pixmap the height of the widget can be created
  44.           and used as the background pixmap by building an argument
  45.           list using the XXXXmmmmNNNNbbbbaaaacccckkkkggggrrrroooouuuunnnnddddPPPPiiiixxxxmmmmaaaapppp argument type as defined
  46.           by CCCCoooorrrreeee.  Whenever the widget is redrawn, its background is
  47.           displayed containing the desired separator drawing.
  48.  
  49.         CCCCllllaaaasssssssseeeessss
  50.           Separator inherits behavior and resources from CCCCoooorrrreeee and
  51.           XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee Classes.
  52.  
  53.           The class pointer is xxxxmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  54.  
  55.           The class name is XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr.
  56.  
  57.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  58.           The following table defines a set of widget resources used
  59.           by the programmer to specify data.  The programmer can also
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           set the resource values for the inherited classes to set
  75.           attributes for this widget.  To reference a resource by name
  76.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  77.           prefix and use the remaining letters.  To specify one of the
  78.           defined values for a resource in a .Xdefaults file, remove
  79.           the XXXXmmmm prefix and use the remaining letters (in either
  80.           lowercase or uppercase, but include any underscores between
  81.           words).  The codes in the access column indicate if the
  82.           given resource can be set at creation time (C), set by using
  83.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  84.           not applicable (N/A).
  85.  
  86.                                  XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  87.      NNNNaaaammmmeeee               CCCCllllaaaassssssss              TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt              AAAAcccccccceeeessssssss
  88.      _________________________________________________________________________________
  89.      XmNmargin          XmCMargin          Dimension       0                    CSG
  90.      XmNorientation     XmCOrientation     unsigned char   XmHORIZONTAL         CSG
  91.      XmNseparatorType   XmCSeparatorType   unsigned char   XmSHADOW_ETCHED_IN   CSG
  92.  
  93.  
  94.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnn For horizontal orientation, specifies the space on
  95.                     the left and right sides between the border of the
  96.                     Separator and the line drawn.  For vertical
  97.                     orientation, specifies the space on the top and
  98.                     bottom between the border of the Separator and the
  99.                     line drawn.
  100.  
  101.           XXXXmmmmNNNNoooorrrriiiieeeennnnttttaaaattttiiiioooonnnn
  102.                     Displays Separator vertically or horizontally.
  103.                     This resource can have values of XXXXmmmmVVVVEEEERRRRTTTTIIIICCCCAAAALLLL and
  104.                     XXXXmmmmHHHHOOOORRRRIIIIZZZZOOOONNNNTTTTAAAALLLL.
  105.  
  106.           XXXXmmmmNNNNsssseeeeppppaaaarrrraaaattttoooorrrrTTTTyyyyppppeeee
  107.                     Specifies the type of line drawing to be done in
  108.                     the Separator widget.
  109.  
  110.  
  111.                       +o  XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____LLLLIIIINNNNEEEE-single line.
  112.  
  113.                       +o  XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____LLLLIIIINNNNEEEE-double line.
  114.  
  115.                       +o  XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE-single-dashed line.
  116.  
  117.                       +o  XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE-double-dashed line.
  118.  
  119.                       +o  XXXXmmmmNNNNOOOO____LLLLIIIINNNNEEEE-no line.
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN-a line whose shadows give
  141.                          the effect of a line etched into the window.
  142.                          The thickness of the line is equal to the
  143.                          value of XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss.  For horizontal
  144.                          orientation, the top shadow is drawn in
  145.                          XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr and the bottom shadow is
  146.                          drawn in XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr.  For vertical
  147.                          orientation, the left edge is drawn in
  148.                          XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr and the right edge is drawn
  149.                          in XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr.
  150.  
  151.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT-a line whose shadows give
  152.                          the effect of an etched line coming out of
  153.                          the window.  The thickness of the line is
  154.                          equal to the value of XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss.
  155.                          For horizontal orientation, the top shadow is
  156.                          drawn in XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr and the bottom
  157.                          shadow is drawn in XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr.  For
  158.                          vertical orientation, the left edge is drawn
  159.                          in XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr and the right edge is
  160.                          drawn in XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr.
  161.  
  162.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN____DDDDAAAASSSSHHHH-identical to
  163.                          XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN except a series of lines
  164.                          creates a dashed line.
  165.  
  166.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT____DDDDAAAASSSSHHHH-identical to
  167.                          XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT except a series of lines
  168.                          creates a dashed line.
  169.  
  170.  
  171.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  172.           Separator inherits behavior and resources from the following
  173.           superclasses.  For a complete description of each resource,
  174.           refer to the man page for that superclass.
  175.  
  176.                                          XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  177.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  178.      ________________________________________________________________________________________________
  179.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic                CSG
  180.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap             XmUNSPECIFIED_PIXMAP   CSG
  181.      XmNforeground           XmCForeground           Pixel              dynamic                CSG
  182.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL                   C
  183.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic                CSG
  184.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False                  CSG
  185.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap             dynamic                CSG
  186.      XmNhighlightThickness   XmCHighlightThickness   Dimension          0                      CSG
  187.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE                 CSG
  188.      XmNshadowThickness      XmCShadowThickness      Dimension          2                      CSG
  189.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic                CSG
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX))))
  203.  
  204.  
  205.  
  206.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap             dynamic                CSG
  207.      XmNtraversalOn          XmCTraversalOn          Boolean            False                  G
  208.      XmNunitType             XmCUnitType             unsigned char      dynamic                CSG
  209.      XmNuserData             XmCUserData             XtPointer          NULL                   CSG
  210.  
  211.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  212.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  213.      ______________________________________________________________________________________________________________
  214.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  215.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  216.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  217.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  218.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  219.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  220.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  221.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  222.      XmNdepth                        XmCDepth                        int              dynamic                CG
  223.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  224.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  225.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  226.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  227.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  228.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  229.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  230.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  231.      XmNx                            XmCPosition                     Position         0                      CSG
  232.      XmNy                            XmCPosition                     Position         0                      CSG
  233.  
  234.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  235.           There are no translations for XmSeparator.
  236.  
  237.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  238.           CCCCoooorrrreeee((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSeeeeppppaaaarrrraaaattttoooorrrr((((3333XXXX)))), and XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee((((3333XXXX)))).
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.